Get test job run status

Retrieves the current status and results of a test job using its run PID. This includes the overall job status, the total number of test cases, and the counts of passed, failed, and not-run cases.

You can monitor the status of an ongoing job using the API described below

GET{accelqLoginUrl}/awb/api/1.0/{tenantCode}/runs/{runPid}

Headers

Header	Value
`user_id`	Login username (email)
`api_key`	API key of the user for authentication
`Content-Type`	application/json
`Accept`	application/json

Parameters

Parameter	Type	Required	Description
`accelqLoginUrl`	string	Yes	Base URL for AccelQ login
`tenantCode`	string	Yes	Tenant code for identifying the organization
`runPid`	integer	Yes	Unique identifier of the test job run
`user_id`	string	Yes	Login username (email)
`api_key`	string	Yes	API key of the user for authentication

Responses

200 - Successful retrieval of job run status

json

{
  "summary": {
    "jobPid": 7092,
    "status": "completed",
    "tagList": [],
    "subStatus": "In progress",
    "reasons": [],
    "errors": [],
    "pass": 1,
    "fail": 0,
    "notRun": 0,
    "testcaseCount": 1,
    "completedTimestamp": 1763728063542,
    "lastUpdatedTimestamp": 0,
    "testCaseSummaryList": [
      {
        "reportVersion": "3.3",
        "id": 0,
        "dbPid": 2794,
        "scnPid": 3060,
        "name": "User Login Validation",
        "status": "pass",
        "lastStatusUpdatedUserName": "",
        "lastErrorStmtMsg": "",
        "startDate": 1763727964458,
        "endDate": 1763728062308,
        "jobPid": 7092,
        "extResultLink": "https://app.accelq.io/#/forward?tenantCode=sampleTenant&projectCode=SampleProject&jobPid=7092&testTypePid=0&scnPid=3060&testCasePid=2794&isAccessAllTC=true",
        "selfHealingCount": null,
        "hostTimezone": "IST",
        "metadata": {
          "Test Field 1": [
            "option 1"
          ],
          "tags": []
        }
      }
    ],
    "reportVersion": "3.3",
    "purpose": "Scenario - User Login Validation",
    "testTypePid": 0,
    "createdBy": "System",
    "startTimestamp": 1763727963640,
    "tenantCode": "sampleTenant",
    "projectCode": "SampleProject",
    "datasetName": "Test",
    "scnCount": 1,
    "testSuiteName": "",
    "scnName": "User Login Validation",
    "scnPid": 3060,
    "hostConfig": {
      "webProviderType": "Local Agent",
      "mobileProviderType": "Local Agent",
      "webConnectionParams": {},
      "mobileConnectionParams": {},
      "agentName": "SampleAgent",
      "agentNamePattern": null,
      "dynamicAgent": false,
      "parallelExecution": false,
      "numOfParallelRuns": 1,
      "webAdditionalCapabilities": "",
      "mobileAdditionalCapabilities": "",
      "webDriverConfigName": "",
      "mobileDriverConfigName": "",
      "browserKeepAlive": true,
      "mobileKeepAlive": false,
      "skipReinstall": false,
      "webPlatformDetails": {
        "os": "Windows",
        "osVersion": "",
        "browser": "Chrome",
        "browserVersion": "",
        "isRealDevice": true,
        "deviceStatus": 3,
        "customDriverUrl": "http://127.0.0.1:4723/wd/hub",
        "appiumDriverUrl": "http://127.0.0.1:4723/wd/hub"
      },
      "mobilePlatformDetails": null,
      "mobilePlatformDetailsList": null,
      "emulatedDeviceDetails": null,
      "tcStmtLineMaxCount": 100000,
      "autoStartBsLocal": true,
      "webOs": "Windows",
      "webOsVersion": "",
      "webBrowser": "Chrome",
      "webBrowserVersion": ""
    },
    "notifyOnStart": true,
    "emailNotificationMode": 1,
    "notificationEmailIds": "user@example.com",
    "debug": false,
    "enableIframeFreeFormSearch": false,
    "settings": {
      "captureScreenshot": "2",
      "enableSelfHealing": "true",
      "pageLoadWaitTime": "60",
      "elementWaitTime": "30",
      "loggerLevel": "VERBOSE",
      "verbose": "false",
      "enableWebAccessibilityTesting": "false",
      "enableWebPerformanceTesting": "false",
      "slaThreshold": "0",
      "apiTimeout": "60"
    },
    "scenarioMetadataDef": {},
    "testCaseMetadataDef": {
      "Test Field 1": [
        "option 1",
        "option 2",
        "option 3"
      ],
      "Platform": [
        "Android",
        "IOS"
      ]
    },
    "runConfig": {},
    "executionParametersJson": "{\"Language\":\"japanese\",\"Release\":\"Release 2024\"}",
    "bugsCount": 0,
    "bugList": [],
    "scenarioList": [
      {
        "name": "User Login Validation",
        "description": "",
        "dbPid": 3060,
        "dataDriven": true,
        "metadata": {
          "Test Field 1": [
            "option 1"
          ]
        },
        "testCases": [],
        "testCasesList": [
          {
            "pid": 2794,
            "name": "User Login Validation"
          }
        ],
        "jiraStoryList": []
      }
    ],
    "autoReRun": false,
    "extResultUrl": "https://app.accelq.io/#/forward?tenantCode=sampleTenant&projectCode=SampleProject&jobPid=7092&testTypePid=0",
    "extResultUrlWithApiCode": "https://app.accelq.io/#/forward?tenantCode=sampleTenant&projectCode=SampleProject&jobPid=7092&testTypePid=0&extApiCode=sampleApiCode",
    "extResultUrlPasscode": "samplePass"
  },
  "parentPid": null,
  "childRunSummaryList": [
    {
      "jobPid": 7092,
      "purpose": "Scenario - User Login Validation",
      "startTimestamp": 1763727963640,
      "datasetName": "Test",
      "testSuiteName": "",
      "scnName": "User Login Validation",
      "status": "completed",
      "subStatus": "In progress",
      "reasons": [],
      "reasonsStr": "",
      "pass": 1,
      "fail": 0,
      "notRun": 0,
      "bugsCount": 0,
      "completedTimestamp": 1763728063542,
      "webPlatformDetails": "{\"os\":\"Windows\",\"osVersion\":\"\",\"browser\":\"Chrome\",\"browserVersion\":\"\",\"isRealDevice\":true,\"deviceStatus\":3,\"customDriverUrl\":\"http://127.0.0.1:4723/wd/hub\"}",
      "createdBy": "System",
      "debug": false,
      "autoReRun": false,
      "testTypePid": 0,
      "consolidated": true,
      "hostConfig": {
        "webProviderType": "Local Agent",
        "mobileProviderType": "Local Agent",
        "webConnectionParams": {},
        "mobileConnectionParams": {},
        "agentName": "SampleAgent",
        "agentNamePattern": null,
        "dynamicAgent": false,
        "parallelExecution": false,
        "numOfParallelRuns": 1,
        "webAdditionalCapabilities": "",
        "mobileAdditionalCapabilities": "",
        "webDriverConfigName": "",
        "mobileDriverConfigName": "",
        "browserKeepAlive": true,
        "mobileKeepAlive": false,
        "skipReinstall": false,
        "webPlatformDetails": {
          "os": "Windows",
          "osVersion": "",
          "browser": "Chrome",
          "browserVersion": "",
          "isRealDevice": true,
          "deviceStatus": 3,
          "customDriverUrl": "http://127.0.0.1:4723/wd/hub",
          "appiumDriverUrl": "http://127.0.0.1:4723/wd/hub"
        },
        "mobilePlatformDetails": null,
        "mobilePlatformDetailsList": null,
        "emulatedDeviceDetails": null,
        "tcStmtLineMaxCount": 100000,
        "autoStartBsLocal": true,
        "webOs": "Windows",
        "webOsVersion": "",
        "webBrowser": "Chrome",
        "webBrowserVersion": ""
      }
    }
  ],
  "testRunStoragePurgeInfo": null,
  "reRunsCount": 0
}

401 - Unauthorized - Invalid or missing authentication credentials

json

{
  "error": "Invalid authentication credentials"
}

404 - Not Found - Job run with specified PID does not exist

json

{
  "error": "Job run with PID 159 does not exist"
}

500 - Internal Server Error

json

{
  "error": "Error occurred while retrieving job run status"
}

cURL Command Builder

URL Parameters

accelqLoginUrl (string) *

tenantCode (string) *

runPid (integer) *

Headers

user_id (string) *

api_key (string) *

Request Sample (cURL)

curl -X GET "${{accelqLoginUrl}}/awb/api/1.0/${{tenantCode}}/runs/${{runPid}}" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"